Skip to content

Add api docs#74

Open
hannahbaumann wants to merge 17 commits intomainfrom
api_docs
Open

Add api docs#74
hannahbaumann wants to merge 17 commits intomainfrom
api_docs

Conversation

@hannahbaumann
Copy link
Contributor

No description provided.

@codecov
Copy link

codecov bot commented Jan 29, 2026

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 96.10%. Comparing base (5260e3b) to head (687b401).
⚠️ Report is 10 commits behind head on main.

Additional details and impacted files
@@            Coverage Diff             @@
##             main      #74      +/-   ##
==========================================
+ Coverage   88.16%   96.10%   +7.94%     
==========================================
  Files           7        6       -1     
  Lines         338      334       -4     
==========================================
+ Hits          298      321      +23     
+ Misses         40       13      -27     

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

@hannahbaumann hannahbaumann self-assigned this Feb 3, 2026
@hannahbaumann
Copy link
Contributor Author

pre-commit.ci autofix

@IAlibay IAlibay requested a review from jthorton February 10, 2026 13:37
Copy link
Member

@IAlibay IAlibay left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Very quick drive-by review.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Are these actually generated files? If not, to avoid confusion, I would say just add the rst files as-is under the api folder alongside the index.

If they are auto-generated, then it's not immediately clear to me that they should be commited.

docs/conf.py Outdated
sass_src_dir = "_sass"
sass_out_dir = "_static/css"

# Clone or update ExampleNotebooks
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

You don't need this here.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

remove?

hannahbaumann and others added 6 commits February 16, 2026 14:17
Co-authored-by: Irfan Alibay <IAlibay@users.noreply.github.com>
Co-authored-by: Irfan Alibay <IAlibay@users.noreply.github.com>
@IAlibay
Copy link
Member

IAlibay commented Feb 16, 2026

I'll let @jthorton do the proper review here.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants